home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 22 / Cream of the Crop 22.iso / program / inter52f.zip / INT2RTF.ZIP / INT2RTF.DOC < prev    next >
Text File  |  1996-10-08  |  5KB  |  110 lines
  1.  === Int2RTF Interrupt List Compiler v0.9 (C) 1996 Slava Gostrenko ===
  2.  
  3.  
  4.      Introduction.
  5.  
  6.      This  program  converts Ralf Brown's Interrupt List into Rich Text Format
  7. (.RTF)  file that may be further compiled with Microsoft Help Compiler such as
  8. HC31.EXE to make Windows Help (.HLP) file.
  9.  
  10.      Int2RTF  uses  hypertext  features of the Interrupt List. It is the first
  11. (and  the  only)  Interrupt  List  compiler that makes a real hypertext of the
  12. Interrupt  List.  It  is  made  possible due to an advanced pattern processing
  13. technique used in the compiler.
  14.  
  15.      Not  only it creates comprehensive indexes for all the topics in the list
  16. but it also allows users to add their own indexes to the help file.
  17.  
  18.  
  19.      Usage.
  20.  
  21.      Unpack  all the Interrupt List and Int2RTF files into one directory. Make
  22. sure  that  there  is  at  least 18Mb of free space left on the drive. You may
  23. need up to 23Mb of free space if you computer has less than 5Mb of RAM. Try to
  24. free  up  to 5Mb of XMS memory (BIOS provided XMS suites as well as the memory
  25. provided  by  himem  or any other XMS driver). The rest of the RAM may be used
  26. for  disk  caching  provided  by any disk cache driver or operating system you
  27. have.
  28.  
  29.      Note  that abovelisted requirements are derived for Int2RTF.EXE itself. I
  30. don't  know  what  are the requirements for Microsoft Help Compiler. I usually
  31. run HC31.EXE with 16Mb of RAM and more than 100Mb of free hard disk space. And
  32. once  I've  got  a low memory error message running HC31.EXE with only 30Mb of
  33. free  hard  disk  space.  But  it  happened  when I was trying to run HC31.EXE
  34. without  preliminarily prepared key-phrase table (.PH file). I guess it should
  35. run  Ok  with 30Mb of free hard disk space if you use key-phrase file supplied
  36. with Int2RTF.
  37.  
  38.      Int2RTF  is  a  protected  mode (DPMI) program. So it is assumed that you
  39. have  alredy  configured  RTM  (DPMI  Runtime  manager that comes with Borland
  40. Pascal).  In fact the actual configuration (with the help of DPMIInst program)
  41. is  required  if  you have a 286 class computer. Otherwise it is only required
  42. that RTM.EXE and DPMI16BI.OVL can be found using PATH environment variable.
  43.  
  44.      Run  Int2HLP.Bat. After a while it will create IntWin.RTF file. Then this
  45. file  will  be  passed  to  HC31.EXE  Microsoft Help Compiler. You should have
  46. HC31.EXE and its related files reachable via PATH environment variable. If you
  47. develop  under  windows you should already have Microsoft Help Compiler. It is
  48. not  supplied within Int2RTF package. Microsoft Help Compiler is not nessesary
  49. called  HC31.EXE, but Int2RTF was tested only witn HC31.EXE and it is HC31.EXE
  50. that  is  called  from  within  Int2HLP.Bat.  Edit  Int2HLP.Bat  if it is your
  51. intention to use another version of Microsoft Help Compiler.
  52.  
  53.      Microsoft  Help  Compiler should produce IntWin.HLP that is the help file
  54. you've been waiting for.
  55.  
  56.      Before  you  start  to use newly created help file please bother yourself
  57. with   copying  of  HintSrch.DLL  supplied  with  Int2RTF  into  your  windows
  58. directory.
  59.  
  60.      To use the help file in windows just double click on its name.
  61.  
  62.      IntWin.RTF  file  is  not  automaticly  deleted.  Delete it yourself when
  63. finished with Microsoft Help Compiler.
  64.  
  65.  
  66.      Note.
  67.  
  68.      Do not rename IntWin.HLP. HintSrch.DLL search engine will stop working if
  69. used not with the file named IntWin.HLP.
  70.  
  71.  
  72.      User defined idexes.
  73.  
  74.      To  define  your  own  index edit Int_Keys.Txt file. It is a list of user
  75. defined  key  words  that  are  used  for  indexing.  Each word in the list is
  76. searched  in  the  Interrupt  List topics. All the topics containing given key
  77. word  will  be  listed  in  the  separate  index  topic. The key word used for
  78. indexing will be the name of the topic.
  79.  
  80.      Int_Bold.Txt  file  is  the  list of the key words that will be displayed
  81. using bold font. You may edit this file too.
  82.  
  83.  
  84.      Technical notes.
  85.  
  86.      While  running Int2RTF creates 2 temporary files. Int2RTF.Swp is the main
  87. swap  file  for  virtual memory. Topics.Swp is the swap file for the Interrupt
  88. List  topics.  Temporary  files  are  deleted on the normal termination of the
  89. program.
  90.  
  91.      The   Incomplt.Log  file  is  a  log  of  the  ambiguous  search  pattern
  92. applications. Normaly you don't need this file.
  93.  
  94.      While  running Int2RTF displays it's current status and may display error
  95. messages.  I've  debugged Int2RTF to run well on the Interrupt List Release 51
  96. and  added  lots  of error checks to the program to make it easier to find the
  97. incompatabilities  of  the  compiler's  algorithms  and  new  releases  of the
  98. Interrupt  List.  So  let me know if you have a newer version of the Interrupt
  99. List that is compiled with errors.
  100.  
  101.  
  102.      E-Mail  me  anytime  you  wish  and  don't forget to visit my homepage at
  103. http://sunny.aha.ru/~gw/ (read http.www file included in this package)! ;-)
  104.  
  105.  
  106. Author:  Slava Gostrenko
  107. E-Mail:  gw@aha.ru
  108. WWW:     http://sunny.aha.ru/~gw/  <- Latest versions and info are here
  109. FidoNet: 2:5020/201.105, 2:5020/468.105
  110.